cs-visual-time-banca-seguros-sapi

(0 reviews)

📘 Documentación de la API - cs-visual-time-banca-seguros-sapi

Esta sección describe los atributos y uso del servicio API cs-visual-time-banca-seguros-sapi.

💂️ Información Base

Título de la API: cs-visual-time-banca-seguros-sapi
Versión: 1.0
URL Base: https://cs-visual-time-banca-seguros-sapi-{env}-v1.us-e1.cloudhub.io/api/Reemplaza {env} con:
- dev (Desarrollo)
- qa (Aseguramiento de Calidad)
- prod (Producción)

🔑 Autenticación

La API implementa dos esquemas de seguridad:

client-id-enforcement
OAuth2

Encabezados Requeridos

Encabezado	Tipo	Descripción
client_id	String	Identificador único para clientes de API
Authorization	String	Token de autorización OAuth2

client_id
- Longitud: 32 - 36 caracteres
- Ejemplo: 123e4567-e89b-12d3-a456-426614174000
Authorization
- Formato: Token Bearer
- Ejemplo: Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9...

📌 Estos encabezados son requeridos en todas las solicitudes.

📊 Encabezados Comunes

La mayoría de endpoints en esta API requieren los siguientes encabezados de solicitud estándar:

Encabezado	Tipo	Requerido	Descripción
Content-Type	String	✅	Tipo de medio del cuerpo de la solicitud
Accept	String	✅	Tipos de medio aceptables para respuesta
client_id	String	✅	Identificador del cliente de API
Authorization	String	✅	Token Bearer OAuth2

Endpoints específicos pueden requerir encabezados adicionales. Consulta la documentación detallada del endpoint para requisitos específicos.

📑 Formato de Solicitud y Respuesta

Formato de Solicitud

La API soporta los siguientes formatos de solicitud:

application/json - Para cargas útiles JSON
application/x-www-form-urlencoded - Para datos de formulario
multipart/form-data - Para cargas de archivos

Formato de Respuesta

La API principalmente retorna respuestas en:

application/json - Para respuestas de datos estructurados
text/plain - Para respuestas de texto simple

Cada respuesta incluye códigos de estado HTTP y encabezados apropiados.

📁 Resumen de Estructura de API

Esta API está organizada en varias áreas funcionales:

Emisión de Pólizas - Gestión del ciclo de vida de emisión de pólizas
Cotizaciones - Operaciones del proceso de cotización
Gestión de Reclamos - Cobertura afectada por reclamos
Cancelaciones de Pólizas - Operaciones de cancelación y remoción
Operaciones PostgreSQL - Interacciones directas con base de datos
Utilidades - Funciones de apoyo y consultas personalizadas
Consultas por Rango de Fecha - Consultas de pólizas basadas en tiempo
Gestión de Documentos - Recuperación de números de documento
Integración de Canal de Ventas - Gestión de módulos por canal de ventas
Personas Aseguradas - Creación y gestión de personas aseguradas
Matriz de Seguros de Vida - Operaciones de matriz de emisión de pólizas de vida

Para información detallada sobre cada endpoint, incluyendo formatos de solicitud/respuesta y parámetros, consulta la documentación específica del endpoint.

🔐 Esquemas de Seguridad

Aplicación de Client ID

Campo	Tipo	Requerido	Longitud	Regex
`client_id`	String	Sí	32 - 36	`[a-zA-Z0-9]`

OAuth2

Campo	Tipo	Requerido	Descripción
`Authorization`	String	Sí	Token Bearer para autorización

La API utiliza tanto client_id-enforcement como OAuth2 como esquemas de seguridad. Todas las solicitudes deben incluir tanto un client_id válido como un token Bearer OAuth2 en los encabezados de la solicitud.

⚠️ Códigos de Error

Código	Descripción	Solución Sugerida
400	Solicitud Incorrecta	Revisar sintaxis de solicitud y parámetros
401	No Autorizado	Validar credenciales de autenticación
404	No Encontrado	Confirmar la URL del endpoint
500	Error Interno del Servidor	Reintentar o contactar soporte técnico

Todos los endpoints de la API implementan manejo común de códigos de error HTTP según se define en la especificación de la API.

📊 Parámetros de Consulta Comunes

Muchos endpoints en esta API aceptan los siguientes parámetros de consulta comunes:

Parámetro	Tipo	Descripción	Ejemplo
startDate	string	Fecha de inicio para consultas por rango	"2024-10-02 00:00:00"
endDate	string	Fecha de fin para consultas por rango	"2024-10-15 23:59:59"
limit	string	Número máximo de resultados a retornar	"10"
productId	number	Identificador del producto	31300
policyId	number	Identificador de póliza	154241
claimNumber	string	Número de reclamo para operaciones de reclamos	"2030007501"
policyNumber	string	Número de póliza	"40998"
company	string	Tipo de empresa (vida-1 o generales-2)	"1"

🔄 Operaciones de Base de Datos

Esta API realiza operaciones directas con base de datos PostgreSQL a través de procedimientos almacenados y funciones. Las operaciones clave de base de datos incluyen:

Asignación de Pólizas: Asignación automática de números de póliza
Actualizaciones de Estado: Actualizaciones de estado en tiempo real para pólizas
Validación de Datos: Validación integral antes de inserción en base de datos
Gestión de Transacciones: Asegurando consistencia de datos a través de operaciones
Pista de Auditoría: Seguimiento de todas las modificaciones de base de datos

📞 Soporte

Para asistencia, contacta al equipo de Coordinación de Servicios de Integración y Aplicaciones.
Correo electrónico: epalma@fgs.co

📅 Información Adicional

Documentación actualizada por última vez: Septiembre 2025
Para actualizaciones adicionales, consulta el Portal de Exchange de API